/**
 * Copyright (c) 2009 Teoti Graphix, LLC See:
 *     http://tkarchitecture.teotigraphix.org
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * @author Michael Schmalle mschmalle@teotigraphix.com
 */
package org.example.ui.event
{

import flash.events.Event;

/**
 * Event class for login related events.
 *
 * @author Michael Schmalle
 * @copyright Teoti Graphix, LLC
 */
public class LoginEvent extends Event
{
	//--------------------------------------------------------------------------
	//
	//  Public Class :: Constants
	//
	//--------------------------------------------------------------------------
	
	/**
	 * The login event dispatched from the LoginComponent.
	 * 
 	 * @eventType login
     */
	public static const LOGIN:String = "login";
	
	/**
	 * The loginComplete event dispatched from the LoginComponent.
	 * 
 	 * @eventType loginComplete
     */
	public static const LOGIN_COMPLETE:String = "loginComplete";	
	
	//--------------------------------------------------------------------------
	//
	//  Public :: Variables
	//
	//--------------------------------------------------------------------------
	
	/**
	 * The client's name.
	 */
	public var username:String;
	
	/**
	 * The client's password.
	 */
	public var password:String;
	
	//--------------------------------------------------------------------------
	//
	//  Constructor
	//
	//--------------------------------------------------------------------------
	
	/**
	 * Constructor.
	 */
	public function LoginEvent(
		type:String, 
		username:String = "", password:String = "", 
		bubbles:Boolean=false, cancelable:Boolean=false) 
	{
		super(type);
		
		this.username = username;
		this.password = password;
	}
	
	//--------------------------------------------------------------------------
	//
	//  Overridden Public :: Methods
	//
	//--------------------------------------------------------------------------
	
	/**
	 * Returns a clone of the event.
	 */
	override public function clone():Event 
	{
		return new LoginEvent(type, username, password, bubbles, cancelable);
	}
	
	/**
	 * Returns a string representation of the event.
	 */
	override public function toString():String 
	{
		return formatToString("LoginEvent", "type", "username", "password", "bubbles", "cancelable");
	}
}
}